/**
 *
 * \file
 * Timeout handling.
 *
 */

/*
 *
 * Copyright (c) 2010, Jesper Hansen
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice, this
 *       list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice,
 *       this list of conditions and the following disclaimer in the documentation
 *       and/or other materials provided with the distribution.
 *     * Neither the name of the copyright holders nor the names of any contributors
 *       may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 */


#ifndef TIMEOUT_H_
#define TIMEOUT_H_



//! \enum timeout_e
//! Type of timeout
//!
typedef enum timeout_e
{
	ONE_SHOT,	//!< Requests a one time timeout
	REPETITIVE	//!< Request a repetitive timeout
} timeout_e;

//! \typedef PFUNC
//! Callback function template
//!
typedef void (*PFUNC)(void);

//!
//! Number of simultaneous timeouts allowed
//!
#define NUM_TIMEOUTS	10

//!
//! Structure for timeout handling
//!
typedef struct timeouts_t
{
	uint32_t 	timeout;	//!< Timeout value
	uint32_t 	reload;		//!< Original timeout requested
	uint8_t 	inuse;		//!< Indicates if this slot is used
	timeout_e 	type;		//!< Type of timeout
	PFUNC 		pfunc;		//!< Pointer to callback function
	uint32_t	flag;
} timeouts_t;


extern volatile unsigned long g_ticker;
extern volatile unsigned long g_flags;


uint32_t timer_set_timeout(uint32_t tmout, PFUNC callback, uint32_t flag, timeout_e tmtype);
void timer_cancel_timeout(uint32_t tmoutkey);
void timeout_tick(uint32_t ulTickMS);
void delay(uint32_t tdelay);
void delayms(uint32_t tdelay);


#endif /* TIMEOUT_H_ */
